#ifndef _PSCI_H
#define _PSCI_H

/*
 * PSCI v0.1 interface
 *
 * The PSCI v0.1 function numbers are implementation defined.
 *
 * Only PSCI return values such as: SUCCESS, NOT_SUPPORTED,
 * INVALID_PARAMS, and DENIED defined below are applicable
 * to PSCI v0.1.
 */

/* PSCI v0.2 interface */
#define PSCI_0_2_FN_BASE					0x84000000
#define PSCI_0_2_FN(n)						(PSCI_0_2_FN_BASE + (n))
#define PSCI_0_2_64BIT						0x40000000
#define PSCI_0_2_FN64_BASE					\
					(PSCI_0_2_FN_BASE + PSCI_0_2_64BIT)
#define PSCI_0_2_FN64(n)					(PSCI_0_2_FN64_BASE + (n))

#define PSCI_0_2_FN_PSCI_VERSION			PSCI_0_2_FN(0)
#define PSCI_0_2_FN_CPU_SUSPEND				PSCI_0_2_FN(1)
#define PSCI_0_2_FN_CPU_OFF					PSCI_0_2_FN(2)
#define PSCI_0_2_FN_CPU_ON					PSCI_0_2_FN(3)
#define PSCI_0_2_FN_AFFINITY_INFO			PSCI_0_2_FN(4)
#define PSCI_0_2_FN_MIGRATE					PSCI_0_2_FN(5)
#define PSCI_0_2_FN_MIGRATE_INFO_TYPE		PSCI_0_2_FN(6)
#define PSCI_0_2_FN_MIGRATE_INFO_UP_CPU		PSCI_0_2_FN(7)
#define PSCI_0_2_FN_SYSTEM_OFF				PSCI_0_2_FN(8)
#define PSCI_0_2_FN_SYSTEM_RESET			PSCI_0_2_FN(9)

#define PSCI_0_2_FN64_CPU_SUSPEND			PSCI_0_2_FN64(1)
#define PSCI_0_2_FN64_CPU_ON				PSCI_0_2_FN64(3)
#define PSCI_0_2_FN64_AFFINITY_INFO			PSCI_0_2_FN64(4)
#define PSCI_0_2_FN64_MIGRATE				PSCI_0_2_FN64(5)
#define PSCI_0_2_FN64_MIGRATE_INFO_UP_CPU	PSCI_0_2_FN64(7)

#define PSCI_1_0_FN_PSCI_FEATURES			PSCI_0_2_FN(10)
#define PSCI_1_0_FN_SYSTEM_SUSPEND			PSCI_0_2_FN(14)

#define PSCI_1_0_FN64_SYSTEM_SUSPEND		PSCI_0_2_FN64(14)

/* PSCI v0.2 power state encoding for CPU_SUSPEND function */
#define PSCI_0_2_POWER_STATE_ID_MASK		0xffff
#define PSCI_0_2_POWER_STATE_ID_SHIFT		0
#define PSCI_0_2_POWER_STATE_TYPE_SHIFT		16
#define PSCI_0_2_POWER_STATE_TYPE_MASK		\
				(0x1 << PSCI_0_2_POWER_STATE_TYPE_SHIFT)
#define PSCI_0_2_POWER_STATE_AFFL_SHIFT		24
#define PSCI_0_2_POWER_STATE_AFFL_MASK		\
				(0x3 << PSCI_0_2_POWER_STATE_AFFL_SHIFT)

/* PSCI extended power state encoding for CPU_SUSPEND function */
#define PSCI_1_0_EXT_POWER_STATE_ID_MASK	0xfffffff
#define PSCI_1_0_EXT_POWER_STATE_ID_SHIFT	0
#define PSCI_1_0_EXT_POWER_STATE_TYPE_SHIFT	30
#define PSCI_1_0_EXT_POWER_STATE_TYPE_MASK	\
				(0x1 << PSCI_1_0_EXT_POWER_STATE_TYPE_SHIFT)

/* PSCI v0.2 affinity level state returned by AFFINITY_INFO */
#define PSCI_0_2_AFFINITY_LEVEL_ON			0
#define PSCI_0_2_AFFINITY_LEVEL_OFF			1
#define PSCI_0_2_AFFINITY_LEVEL_ON_PENDING	2

/* PSCI v0.2 multicore support in Trusted OS returned by MIGRATE_INFO_TYPE */
#define PSCI_0_2_TOS_UP_MIGRATE				0
#define PSCI_0_2_TOS_UP_NO_MIGRATE			1
#define PSCI_0_2_TOS_MP						2

/* PSCI version decoding (independent of PSCI version) */
#define PSCI_VERSION_MAJOR_SHIFT			16
#define PSCI_VERSION_MINOR_MASK				\
		((1U << PSCI_VERSION_MAJOR_SHIFT) - 1)
#define PSCI_VERSION_MAJOR_MASK				~PSCI_VERSION_MINOR_MASK
#define PSCI_VERSION_MAJOR(ver)				\
		(((ver) & PSCI_VERSION_MAJOR_MASK) >> PSCI_VERSION_MAJOR_SHIFT)
#define PSCI_VERSION_MINOR(ver)				\
		((ver) & PSCI_VERSION_MINOR_MASK)
#define PSCI_VERSION(maj, min)				\
	((((maj) << PSCI_VERSION_MAJOR_SHIFT) & PSCI_VERSION_MAJOR_MASK) | \
	 ((min) & PSCI_VERSION_MINOR_MASK))

/* PSCI features decoding (>=1.0) */
#define PSCI_1_0_FEATURES_CPU_SUSPEND_PF_SHIFT	1
#define PSCI_1_0_FEATURES_CPU_SUSPEND_PF_MASK	\
			(0x1 << PSCI_1_0_FEATURES_CPU_SUSPEND_PF_SHIFT)

/* PSCI return values (inclusive of all PSCI versions) */
#define PSCI_RET_SUCCESS				0
#define PSCI_RET_NOT_SUPPORTED			-1
#define PSCI_RET_INVALID_PARAMS			-2
#define PSCI_RET_DENIED					-3
#define PSCI_RET_ALREADY_ON				-4
#define PSCI_RET_ON_PENDING				-5
#define PSCI_RET_INTERNAL_FAILURE		-6
#define PSCI_RET_NOT_PRESENT			-7
#define PSCI_RET_DISABLED				-8
#define PSCI_RET_INVALID_ADDRESS		-9

#ifndef _ASMLANGUAGE

uint32_t psci_get_version(void);
int psci_cpu_suspend(uint32_t state, unsigned long entry_point);
int psci_cpu_off(void);
int psci_cpu_on(unsigned long cpuid, unsigned long entry_point);
int psci_affinity_info(unsigned long target_affinity, unsigned long lowest_affinity_level);

void psci_sys_reset(void);
void psci_sys_poweroff(void);

int psci_init(void);

#endif /* !_ASMLANGUAGE */

#endif /* _PSCI_H */
